<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="ListCollectionView,mx.collections.ListCollectionView,localIndex,filterFunction,length,list,sort,addEventListener,addItem,addItemAt,contains,createCursor,disableAutoUpdate,dispatchEvent,enableAutoUpdate,getItemAt,getItemIndex,hasEventListener,initialized,itemUpdated,refresh,removeAll,removeEventListener,removeItemAt,setItemAt,toArray,toString,willTrigger" name="keywords">
<title>mx.collections.ListCollectionView</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'ListCollectionView - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/collections/ListCollectionView.html&amp;mx/collections/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;ListCollectionView</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class ListCollectionView"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.collections</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ListCollectionView</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ListCollectionView <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.utils.Proxy</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="ICollectionView.html">ICollectionView</a>, <a href="IList.html">IList</a>, <a href="../core/IMXMLObject.html">IMXMLObject</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Subclasses</td><td><a href="../collections/ArrayCollection.html">ArrayCollection</a>, <a href="../collections/XMLListCollection.html">XMLListCollection</a></td>
</tr>
</table>
<p></p>
 The ListCollectionView class adds the properties and methods of the
 <code>ICollectionView</code> interface to an object that conforms to the
 <code>IList</code> interface. As a result, you can pass an object of this class
 to anything that requires an <code>IList</code> or <code>ICollectionView</code>.
  <p>This class also lets you use [ ] array notation
 to access the <code>getItemAt()</code> and <code>setItemAt()</code> methods.
 If you use code such as <code>myListCollectionView[index]</code>
 Flex calls the <code>myListCollectionView</code> object's
 <code>getItemAt()</code> or <code>setItemAt()</code> method.</p>
 
 <p></p>
<a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span style="display:none" id="showMxmlLink"><a onclick="toggleMXMLOnly();" href="#mxmlSyntaxSummary"><img class="collapsedImage" alt="collapsed" title="collapsed" src="../../images/collapsed.gif"> Show MXML Syntax</a>
<br>
</span><span id="hideMxmlLink"><a onclick="toggleMXMLOnly();" href="#mxmlSyntaxSummary"><img class="expandedImage" alt="expanded" title="expanded" src="../../images/expanded.gif"> Hide MXML Syntax</a></span>
<div class="mxmlSyntax" id="mxmlSyntax">   <p>The <code>&lt;mx:ListCollectionView&gt;</code> has the following attributes,
  which all of its subclasses inherit:</p>
   <pre>
  &lt;mx:ListCollectionView
  <b>Properties</b>
  filterFunction="null"
  list="null"
  sort="null"
  <b>Events</b>
  collectionChange="<i>No default</i>"
  /&gt;
  </pre>
 </div>
<script type="text/javascript" language="javascript">
<!--
setMXMLOnly();
--></script>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#filterFunction">filterFunction</a> : Function<div class="summaryTableDescription">
      
      A function that the view will use to eliminate items that do not
      match the function's criteria.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#length">length</a> : int<div class="summaryTableDescription">[read-only]
      
      The number of items in this collection.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#list">list</a> : <a href="../collections/IList.html">IList</a>
<div class="summaryTableDescription">
      The IList that this collection view wraps.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#sort">sort</a> : <a href="../collections/Sort.html">Sort</a>
<div class="summaryTableDescription">
      
      The Sort that will be applied to the ICollectionView.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
</table>
</div>
<a name="protectedPropertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Properties</div>
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#localIndex">localIndex</a> : Array<div class="summaryTableDescription">
      When the view is sorted or filtered the <code>localIndex</code> property
      contains an array of items in the sorted or filtered (ordered, reduced)
      view, in the sorted order.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#ListCollectionView()">ListCollectionView</a>(list:<a href="IList.html">IList</a> = null)</div>
<div class="summaryTableDescription">
      The ListCollectionView constructor.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addEventListener()">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void</div>
<div class="summaryTableDescription">
      </div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addItem()">addItem</a>(item:Object):void</div>
<div class="summaryTableDescription">
     
      Adds the specified item to the end of the list.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addItemAt()">addItemAt</a>(item:Object, index:int):void</div>
<div class="summaryTableDescription">
     
      Adds the item at the specified index.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#contains()">contains</a>(item:Object):Boolean</div>
<div class="summaryTableDescription">
      
      Returns whether the view contains the specified object.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createCursor()">createCursor</a>():<a href="../collections/IViewCursor.html">IViewCursor</a>
</div>
<div class="summaryTableDescription">
      
      Creates a new IViewCursor that works with this view.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#disableAutoUpdate()">disableAutoUpdate</a>():void</div>
<div class="summaryTableDescription">
      
      Prevents changes to the collection itself and items within the
   collection from being dispatched by the view.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#dispatchEvent()">dispatchEvent</a>(event:Event):Boolean</div>
<div class="summaryTableDescription">
      </div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#enableAutoUpdate()">enableAutoUpdate</a>():void</div>
<div class="summaryTableDescription">
      
      Enables auto-updating.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getItemAt()">getItemAt</a>(index:int, prefetch:int = 0):Object</div>
<div class="summaryTableDescription">
     
      Gets the item at the specified index.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getItemIndex()">getItemIndex</a>(item:Object):int</div>
<div class="summaryTableDescription">
     
      Returns the index of the item if it is in the list such that
      getItemAt(index) == item.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hasEventListener()">hasEventListener</a>(type:String):Boolean</div>
<div class="summaryTableDescription">
      </div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initialized()">initialized</a>(document:Object, id:String):void</div>
<div class="summaryTableDescription">
       Called automatically by the MXML compiler when the ListCollectionView
       is created using an MXML tag.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#itemUpdated()">itemUpdated</a>(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void</div>
<div class="summaryTableDescription">
      
      Notifies the view that an item has been updated.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#refresh()">refresh</a>():Boolean</div>
<div class="summaryTableDescription">
     
      Applies the sort and filter to the view.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeAll()">removeAll</a>():void</div>
<div class="summaryTableDescription">
     Remove all items from the list.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeEventListener()">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div>
<div class="summaryTableDescription">
      </div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeItemAt()">removeItemAt</a>(index:int):Object</div>
<div class="summaryTableDescription">
     
      Removes the item at the specified index and returns it.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setItemAt()">setItemAt</a>(item:Object, index:int):Object</div>
<div class="summaryTableDescription">
     
      Places the item at the specified index.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#toArray()">toArray</a>():Array</div>
<div class="summaryTableDescription">
     
      Returns an Array that is populated in the same order as the IList
      implementation.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#toString()">toString</a>():String</div>
<div class="summaryTableDescription">
      Pretty prints the contents of this view to a string and returns it.</div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#willTrigger()">willTrigger</a>(type:String):Boolean</div>
<div class="summaryTableDescription">
      </div>
</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:collectionChange">collectionChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when the ICollectionView has been updated in some way.</td><td class="summaryTableOwnerCol">ListCollectionView</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="filterFunction"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">filterFunction</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>filterFunction:Function</code>&nbsp;&nbsp;[read-write]<p>
      
      A function that the view will use to eliminate items that do not
      match the function's criteria.
   A filterFunction is expected to have the following signature:
     <pre>f(item:Object):Boolean</pre>
     where the return value is <code>true</code> if the specified item
   should remain in the view.
        </p><p>If a filter is unsupported, Flex throws an error when accessing
      this property.
      You must call <code>refresh()</code> after setting the
   <code>filterFunction</code> property for the view to update.</p>
      <p>Note: The Flex implementations of ICollectionView retrieve all
   items from a remote location before executing the filter function.
   If you use paging, apply the filter to the remote collection before
   you retrieve the data.</p>
        <p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get filterFunction():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set filterFunction(value:Function):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/ListCollectionView.html#refresh()" target="">refresh()</a>
</div>
</div>
<a name="length"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">length</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>length:int</code>&nbsp;&nbsp;[read-only]<p>
      
      The number of items in this collection. 
      0 means no items while -1 means the length is unknown. 
     </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get length():int</code>
<br>
</div>
<a name="list"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">list</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>list:<a href="../collections/IList.html">IList</a></code>&nbsp;&nbsp;[read-write]<p>
      The IList that this collection view wraps.
     </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get list():<a href="../collections/IList.html">IList</a></code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set list(value:<a href="../collections/IList.html">IList</a>):void</code>
<br>
</div>
<a name="localIndex"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">localIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected var localIndex:Array</code><p>
      When the view is sorted or filtered the <code>localIndex</code> property
      contains an array of items in the sorted or filtered (ordered, reduced)
      view, in the sorted order.
      The ListCollectionView class uses this property to access the items in 
      the view.
      The <code>localIndex</code> property should never contain anything
      that is not in the source, but may not have everything in the source.  
      This property is <code>null</code> when there is no sort.
     </p></div>
<a name="sort"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">sort</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>sort:<a href="../collections/Sort.html">Sort</a></code>&nbsp;&nbsp;[read-write]<p>
      
      The Sort that will be applied to the ICollectionView.
   Setting the sort does not automatically refresh the view,
   so you must call the <code>refresh()</code> method
   after setting this property.
      If sort is unsupported an error will be thrown when accessing
      this property.
     </p><p>Note: The Flex implementations of ICollectionView retrieve all
   items from a remote location before executing a sort.
   If you use paging with a sorted list, apply the sort to the remote
   collection before you retrieve the data.</p>
        <p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get sort():<a href="../collections/Sort.html">Sort</a></code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set sort(value:<a href="../collections/Sort.html">Sort</a>):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/ListCollectionView.html#refresh()" target="">refresh()</a>
</div>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="ListCollectionView()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ListCollectionView</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function ListCollectionView(list:<a href="IList.html">IList</a> = null)</code><p>
      The ListCollectionView constructor.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">list</span>:<a href="IList.html">IList</a></code> (default = <code>null</code>)<code></code> &mdash; the IList this ListCollectionView is meant to wrap.
     </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addEventListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void</code><p>
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">useCapture</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">useWeakReference</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
</div>
<a name="addItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function addItem(item:Object):void</code><p>
     
      Adds the specified item to the end of the list.
      Equivalent to <code>addItemAt(item, length)</code>.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The item to add.
     </td>
</tr>
</table>
</div>
<a name="addItemAt()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addItemAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function addItemAt(item:Object, index:int):void</code><p>
     
      Adds the item at the specified index.  
      The index of any item greater than the index of the added item is increased by one.  
      If the the specified index is less than zero or greater than the length
      of the list, a RangeError is thrown.
     
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The item to place at the index.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The index at which to place the item.
           </td>
</tr>
</table>
</div>
<a name="contains()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">contains</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function contains(item:Object):Boolean</code><p>
      
      Returns whether the view contains the specified object.
   Unlike the <code>IViewCursor.find<i>xxx</i></code> methods,
   this search is succesful only if it finds an item that exactly
   matches the parameter.
      If the view has a filter applied to it this method may return
   <code>false</code> even if the underlying collection
   does contain the item.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The object to look for.
        </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if the ICollectionView, after applying any filter,
      contains the item; false otherwise.
     </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/ListCollectionView.html#enableAutoUpdate()" target="">enableAutoUpdate()</a>
<br>
<a href="../events/CollectionEvent.html" target="">mx.events.CollectionEvent</a>
</div>
</div>
<a name="createCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function createCursor():<a href="../collections/IViewCursor.html">IViewCursor</a></code><p>
      
      Creates a new IViewCursor that works with this view.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../collections/IViewCursor.html">IViewCursor</a></code> &mdash; 
                        A new IViewCursor implementation.
          
                        
                     </td>
</tr>
</table>
</div>
<a name="disableAutoUpdate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">disableAutoUpdate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function disableAutoUpdate():void</code><p>
      
      Prevents changes to the collection itself and items within the
   collection from being dispatched by the view.
   Also prevents the view from updating the positions of items
   if the positions change in the collection.
   The changes will be queued and dispatched appropriately
   after <code>enableAutoUpdate</code> is called.
   If more events than updates to a single item occur,
   the view may end up resetting. 
   The <code>disableAutoUpdate</code> method acts cumulatively;
   the same number of calls to <code>enableAutoUpdate</code>
   are required for the view to dispatch events and refresh.
   Note that <code>disableAutoUpdate</code> only affects the
      individual view; edits may be detected on an individual
   basis by other views.
     </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/ICollectionView.html#enableAutoUpdate()" target="">mx.collections.ICollectionView.enableAutoUpdate()</a>
<br>
<a href="../events/CollectionEvent.html" target="">mx.events.CollectionEvent</a>
</div>
</div>
<a name="dispatchEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dispatchEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function dispatchEvent(event:Event):Boolean</code><p>
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">event</span>:Event</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<a name="enableAutoUpdate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enableAutoUpdate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function enableAutoUpdate():void</code><p>
      
      Enables auto-updating.
   See <code>disableAutoUpdate</code> for more information.
        </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/ICollectionView.html#disableAutoUpdate()" target="">mx.collections.ICollectionView.disableAutoUpdate()</a>
</div>
</div>
<a name="getItemAt()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getItemAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getItemAt(index:int, prefetch:int = 0):Object</code><p>
     
      Gets the item at the specified index.
     
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The index in the list from which to retrieve the item.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">prefetch</span>:int</code> (default = <code>0</code>)<code></code> &mdash; An <code>int</code> indicating both the direction
      and number of items to fetch during the request if the item is
      not local.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The item at that index, or <code>null</code> if there is none.
           </td>
</tr>
</table>
</div>
<a name="getItemIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getItemIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getItemIndex(item:Object):int</code><p>
     
      Returns the index of the item if it is in the list such that
      getItemAt(index) == item.
     
      </p><p>Note: unlike <code>IViewCursor.find<i>xxx</i>()</code> methods,
      The <code>getItemIndex()</code> method cannot take a parameter with 
      only a subset of the fields in the item being serched for; 
      this method always searches for an item that exactly matches
      the input parameter.</p>
     
      <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The item to find.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; The index of the item, or -1 if the item is not in the list.
     </td>
</tr>
</table>
</div>
<a name="hasEventListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hasEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function hasEventListener(type:String):Boolean</code><p>
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<a name="initialized()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function initialized(document:Object, id:String):void</code><p>
       Called automatically by the MXML compiler when the ListCollectionView
       is created using an MXML tag.  
       If you create the ListCollectionView through ActionScript, you 
       must call this method passing in the MXML document and 
       <code>null</code> for the <code>id</code>.
             </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">document</span>:Object</code> &mdash; The MXML document containing this ListCollectionView.
             </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; Ignored.
      </td>
</tr>
</table>
</div>
<a name="itemUpdated()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemUpdated</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void</code><p>
      
      Notifies the view that an item has been updated.  
      This is useful if the contents of the view do not implement 
      <code>IEventDispatcher</code> and dispatches a 
      <code>PropertyChangeEvent</code>.  
      If a property is specified the view may be able to optimize its 
      notification mechanism.
      Otherwise it may choose to simply refresh the whole view.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The item within the view that was updated.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">property</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; The name of the property that was updated.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">oldValue</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; The old value of that property. (If property was null,
      this can be the old value of the item.)
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">newValue</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; The new value of that property. (If property was null,
      there's no need to specify this as the item is assumed to be
      the new value.)
           </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../events/CollectionEvent.html" target="">mx.events.CollectionEvent</a>
<br>
<a href="../core/IPropertyChangeNotifier.html" target="">mx.core.IPropertyChangeNotifier</a>
<br>
<a href="../events/PropertyChangeEvent.html" target="">mx.events.PropertyChangeEvent</a>
</div>
</div>
<a name="refresh()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">refresh</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function refresh():Boolean</code><p>
     
      Applies the sort and filter to the view.
   The ICollectionView does not detect changes to a sort or
   filter automatically, so you must call the <code>refresh()</code>
   method to update the view after setting the <code>sort</code> 
   or <code>filterFunction</code> property.
   If your ICollectionView implementation also implements
   the IMXMLObject interface, you should to call the
   <code>refresh()</code> method from your <code>initialized()</code>
   method.
        </p><p>Returns <code>true</code> if the refresh was successful
   and <code>false</code> if the sort is not yet complete
   (e.g., items are still pending).
   A client of the view should wait for a CollectionEvent event
   with the <code>CollectionEventKind.REFRESH</code> <code>kind</code>
   property to ensure that the <code>refresh()</code> operation is
   complete.</p>
           <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; <code>true</code> if the refresh() was complete,
   <code>false</code> if the refresh() is incomplete.
     </td>
</tr>
</table>
</div>
<a name="removeAll()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeAll():void</code><p>
     Remove all items from the list.
     </p></div>
<a name="removeEventListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void</code><p>
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">useCapture</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
</div>
<a name="removeItemAt()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeItemAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeItemAt(index:int):Object</code><p>
     
      Removes the item at the specified index and returns it.  
      Any items that were after this index are now one index earlier.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The index from which to remove the item.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The item that was removed.
           </td>
</tr>
</table>
</div>
<a name="setItemAt()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setItemAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setItemAt(item:Object, index:int):Object</code><p>
     
      Places the item at the specified index.  
      If an item was already at that index the new item will replace it
      and it will be returned.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The new item to be placed at the specified index.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The index at which to place the item.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The item that was replaced, or <code>null</code> if none.
           </td>
</tr>
</table>
</div>
<a name="toArray()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">toArray</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function toArray():Array</code><p>
     
      Returns an Array that is populated in the same order as the IList
      implementation.
      This method may throw an ItemPendingError.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code></td>
</tr>
</table>
</div>
<a name="toString()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function toString():String</code><p>
      Pretty prints the contents of this view to a string and returns it.
     </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code></td>
</tr>
</table>
</div>
<a name="willTrigger()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">willTrigger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function willTrigger(type:String):Boolean</code><p>
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:collectionChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">collectionChange</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../events/CollectionEvent.html"><code>mx.events.CollectionEvent</code></a>
<br>
<span class="label">CollectionEvent.type property = </span><a href="../events/CollectionEvent.html#COLLECTION_CHANGE"><code>mx.events.CollectionEvent.COLLECTION_CHANGE</code></a>
<br><p>
  Dispatched when the ICollectionView has been updated in some way.
   </p><p>
      The CollectionEvent.COLLECTION_CHANGE constant defines the value of the
      <code>type</code> property of the event object for an event that is
      dispatched when a collection has changed.
           </p><p>The properties of the event object have the following values.
      Not all properties are meaningful for all kinds of events.
   See the detailed property descriptions for more information.</p>
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
           event listener that handles the event. For example, if you use
           <code>myButton.addEventListener()</code> to register an event listener,
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>items</code></td><td>An Array of objects with
           information about the items affected by the event.
     The contents of this field depend on the event kind;
        for details see the <code>items</code> property</td></tr>
         <tr><td><code>kind</code></td><td>The kind of event.
           The valid values are defined in the CollectionEventKind 
        class as constants.</td></tr>
         <tr><td><code>location</code></td><td>Location within the target collection
             of the item(s) specified in the <code>items</code> property.</td></tr>
         <tr><td><code>oldLocation</code></td><td>the previous location in the collection
             of the item specified in the <code>items</code> property.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
         <tr><td><code>type</code></td><td>CollectionEvent.COLLECTION_CHANGE</td></tr>
      </table>
           </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
